home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 23 / CU Amiga - Super CD-ROM 23 (June 1998).iso / CUCD / Programming / OUI / envman.lha / EnvManager / envman.txt < prev    next >
Encoding:
Text File  |  1996-09-10  |  9.4 KB  |  241 lines
  1.  
  2. Welcome to the EnvMan documentation.
  3. You can select the following topics.
  4.  
  5.  
  6.  
  7. «Introduction»What is EnvMan ?
  8.  
  9. «Copyright»For the distribution
  10.  
  11. «Using EnvMan»How to use it ?
  12.  
  13. «Installation»How to install it ?
  14.  
  15. «How To»You want it ? You'll got it ;)
  16.  
  17. «TroubleShooting»The undocumented features
  18.  
  19. «The Future»How to make it bigger and more complex
  20.  
  21. «The Author»If you don't know me
  22.  
  23. «Object User Interface»What is OUI ?
  24.  
  25. «Localisation»How to get a real catalog
  26.  
  27.  
  28.  
  29. For a very long time I did'nt bother at any time of what was placed in
  30. my ENV: and ENVARC: directories and I let the stuff growing bigger and
  31. bigger until one day I considered the fact that my system was containing a
  32. LOT of environment variables, even for applications I have desinstalled a
  33. long time ago.
  34.  
  35. Then I have realized that I had lost the control of a really important
  36. part of the system which is the environnement.
  37.  
  38. First of all, I think that the environnement is too much used by
  39. applications. Because a really smart alternative are the icon tooltypes.
  40. Any program can have its options controled by the tooltypes
  41. and the smart point is that if you launch a program with a project icon, it
  42. will use the options set in this icon and not those of the tool icon.
  43. Then you can have a lot of different options for the same program, each
  44. controlled by a different project icon. In my humble opinion, the environment
  45. variables should only be used if they are of interest for more than one
  46. application which I believe they have been designed for.
  47.  
  48. The second point is that often, the environment variables are misused by
  49. applications. This is because the variables are of three kinds : local, global
  50. and archived. The local variables are used by few programs to set their
  51. options and it is definitely a mistake because these variables only exist
  52. with the process which created them. The only interest of local variables
  53. is for setting temporary values such as SET ECHO ON of the shell.
  54.  
  55. The third point which I was not happy with is that if you create an
  56. environnement variable, you have no simple way of modifying it. For example
  57. you can not have it global easily.
  58.  
  59. Then I have designed what EnvMan should be:
  60.  
  61.  
  62. · Since some programs set options which disappear at reboot time
  63. or worse, at the end of their process, it should be easy with EnvMan to
  64. set those as global so I can configure the application once and don't
  65. bother about it later.
  66.  
  67. · It must of course, show me the contents of all the environment and how
  68. much place it takes in memory.
  69.  
  70. · It must be easy with EnvMan to create, search or delete any environment
  71. variable and to make promotion of a local variable to the global or archive
  72. set (CLI only). The local variable should not be deletable since this can be
  73. harmful to the system. I have also considered that grabbing local variables
  74. from other processes would not be system friendly.
  75.  
  76. · The environment variables should be editable, if this can be done. Some
  77. are just a text string and it makes no problem but other are text files
  78. or even binary files such as IFF ILBM. The three methods are 1) A string
  79. gadget, 2) A file edit feature and 3) An Import/Export feature. Please
  80. note that the file edition uses C:Ed by default but looks at the environment
  81. variable EDITOR which is also used by the More program and other utilities.
  82. Setting the environment variable EDITOR to your favorite text editor is a must
  83. and don't take a lot of place in memory.
  84.  
  85.  
  86.  
  87.  
  88. EnvMan, Copyright © 1996 Dominique Lorre, All rights reserved
  89.  
  90.  
  91.  
  92. EnvMan is FreeWare, you can use it and distribute it like you want.
  93.  
  94.  
  95. Restrictions
  96.  
  97.  
  98. Distribution of EnvMan in a magazine cover disk or as part of another
  99. product is subject to a signed agreement from the author. The distribution
  100. of EnvMan on any free software collection such as Aminet is allowed without
  101. a signed agreement but only as an independent product, not as an extra of
  102. another application.
  103.  
  104.  
  105. Conditions of distribution
  106.  
  107.  
  108. The envman archive method (currently lha) can be changed provided that the
  109. dearchiving program is available on Amiga or the new archive is self auto-extractable
  110. on any Amiga system greater or equal to 2.0.
  111. The archive contents must be preserved intact but you are authorized to add
  112. a simple file belonging to your organisation if you want and are also welcome
  113. if you add new translations of catalogs or help files (in this case I would prefer
  114. if you send those directly to me so I could include them in the next release).
  115.  
  116.  
  117. THE AUTHOR OF THIS PRODUCT CAN NOT IN ANY EVENT BEING HELD RESPONSIBLE
  118. OF ANY DAMAGE DIRECT OR INDIRECT CAUSED TO YOUR DATAS. THIS PRODUCT IS
  119. GIVEN AS IS AND IS SUBJECT TO CHANGES WITHOUT NOTIFICATIONS.
  120.  
  121.  
  122.  
  123. EnvMan usage is very simple. You can launch it either from the Shell or
  124. the Workbench. There are no options since I didn't find any interesting
  125. options to implement.
  126.  
  127. If you launch EnvMan from the Shell, you will find generally more information
  128. since more local variables and alias will be declared, but this is not
  129. always true, especially if your Shell has been launched without the
  130. S:Shell-Startup initialization file. Some variables like RC, process and
  131. Result2, are systems variables and you should not try to promote such local
  132. variables, since other Shell programs might find this confusing. This
  133. is the reason why I have disabled any modification or suppression of local
  134. variables.
  135.  
  136. If EnvMan takes a LOT of time to appear, this means that you have a HUGE
  137. environment size (200 Kbytes is NOT science-fiction !) and that a little
  138. cleanup might help you gaining more RAM, more space to your SYS: partition
  139. and also having a faster booting process since the environment is transfered
  140. at every boot time from ENVARC: to ENV:...
  141.  
  142. Then, when EnvMan has checked all of your environment, it creates a window
  143. with three lists one for the local variables, one for the global ones and the
  144. third list is for the archives. There is also a button for the create/search
  145. facility. The GUI considerations are discussed under the OUI paragraph.
  146.  
  147. In the lists, all the environment variables are displayed in the alphabetical
  148. order with their full path name. I did not implement a directory based display
  149. since I noticed that some variables are quite hard to search for since they
  150. can be hidden under two or three directories nodes. However, I can change my
  151. mind in the future, especially if many users ask for it with good reasons.
  152. After the variables name, you will find the beginning of their contents and
  153. will be able to identify their types (for example an IFF file will begin
  154. with the FORM letters).
  155.  
  156. To edit a variable, just click on it into the list and a window will open with
  157. the following settings :
  158.  
  159.  : the box is checked if the variable is an alias. You can
  160. not modify this state.
  161.  
  162.  : the box is checked if the variable is local. This is not modifiable.
  163.  
  164.  : checking this box promote your variable to Global and unchecking it
  165. delete the variable from ENV:
  166.  
  167.  : checking this box promote the variable to Archive and unchecking it
  168. delete the variable from ENVARC:.
  169.  
  170.  : the variable is probably a binary file, since EnvMan has detected
  171. control codes. You cannot modify this state.
  172.  
  173.  : the variable is a string with a Null character at its end. This
  174. state may not be modified but the variable is editable via a string gadget.
  175.  
  176.  : the size of the variable.
  177.  
  178.  : the name of the variable. You can edit the name if you want but it
  179. has no effect in this version.
  180.  
  181.  : the contents of the variable will be displayed. If the conditions
  182. are good, you will be able to modify the contents inside the string gadget.
  183. Good conditions are : the variable is not binary and it is global or archived.
  184. Note that you can modify a local variable but this will have effect only if
  185. you check the Global or Archived box since local variables are READ-ONLY.
  186. This also means that the local part will NEVER be modified.
  187.  
  188.  : click on this button to Edit the variable. The file editor will
  189. be C:Ed or the EDITOR variable contents.
  190.  
  191.  : click on this button to replace the contents of this variable
  192. by a file of your choice.
  193.  
  194.  : click on this button to make a copy of this variable in a file of
  195. your choice.
  196.  
  197.  
  198.  
  199. How to create a new variable ?
  200.  
  201. You can create a new variable by selecting the button Create/Sarch
  202.  
  203. How to edit a variable ?
  204.  
  205. By selecting the variable on the list where it appears
  206.  
  207. How to delete a variable ?
  208.  
  209. You can delete a variable by first editing it and setting the Global and
  210. Archived attributes to off
  211.  
  212. How can I modify the contents of a variable ?
  213.  
  214. If the variable is a single text string you can modify it with a string gadget
  215. other possibilities are Import/Export and Edition.
  216.  
  217. Why can't I modify or delete a local variable ?
  218.  
  219. This may be a source of problems to your system but you can still promote
  220. it to global or archived and modify it later.
  221.  
  222. The lists are very long, how can I find a variable quickly ?
  223.  
  224. When you select the create/search button, a new variable will only be
  225. created if it was not existing already. If you specify the name of an
  226. existing variable, the variable will be found and displayed.
  227.  
  228. What does [ALIAS] mean ? I can't have those variables promoted !
  229.  
  230. Yes, alias are special local variable that are generally declared in
  231. the S:Shell-Startup file. Alias allow renaming of long command lines to
  232. a shorter command. Modifying is not allowed since it can be a source of
  233. troubles. If you want to modify those you will be obliged to edit the
  234. S:Shell-Startup file.
  235.  
  236. Why can't I edit a file variable ?
  237.  
  238. EnvMan checks if a file variable is text only. If not, you can still Export it
  239. to a file, modify it and Import it after the modifications have been made.
  240.  
  241.